[Top] [Prev] [Next] [Bottom] [Contents]

safilter

safilter (Framework master only)
safilterN  (for detail where N is required and is the 
detail number)

Definition

A string specifying a comma-separated list of data filter objects to add a data filter to the Graph views of the Sapphire Java Framework Sa.SaGraphRowSet and Sa.SaGraphComp. It also works for classes derived from these view classes. Each substring is the name of a class which implements the interface Sa.SaDataFilter.

Requirements

For each class specified by the substrings of this parameter, if the class is not derived as stated above, then the whole filter is discarded.
If the class cannot be found, then the whole filter is discarded.
The class must contain no constructor or one with no parameters and the constructor should be public. If not then the class will not be loadable, and the whole filter is discarded.
If the filter specification is valid, a menu item is added to the filters menu of the graph view.
The label of the menu item is obtained from the parameter "safilterlabel".

For the master view, the parameter name is "safilter".

For the detail views the parameter name is "safilterN", where N is the detail number.

Filter Syntax

The exact syntax of the filter specification is the most complex in the Framework. The specification is a comma-separated list of parallel filters whose outputs are added together.

Each substring can contain a pipe (the "|" character) delimited list of serially applied transforms, the input of one tied to the output of the previous.
Each of these substrings can contain just a filter class name or a class name followed by an equal sign with an optional string parameter which is passed to the filter object.

Examples

Example 1

<param name="safilter2" 
value="SaC.SaMult=10,SaC.SaAdd=3,SaC.SaMult=10|SaC.
SaMult=10" >
<param name="safilterlabel2" value="100x^2 + 11x + 3">

builds a data converter that implements

10x + (x + 3) + (10x X 10x)

Example 2

<param name="safilter3" value="SaC.SaMult=12" >
<param name="safilterlabel2" value="yearly amount" >

builds a data converter that implements

12x

Notes

The Data Control does not use this parameter.
If the parameter is specified for the master, it will be used by all details unless specifically set with for a detail using the detail number in the parameter.

[Top] [Prev] [Next] [Bottom] [Contents]

info@bluestone.com

Copyright © 1997, Bluestone. All rights reserved.